<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: util/sync_io/detail/timer_ev_emitter.cpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.2</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_a762a7cb84c76c9561dbc78c61068184.html">util</a></li><li class="navelem"><a class="el" href="dir_ff5224d8270264443126f24ce9d073a6.html">sync_io</a></li><li class="navelem"><a class="el" href="dir_a420192279ad82031659f8871fdc90c6.html">detail</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">timer_ev_emitter.cpp</div></div>
</div><!--header-->
<div class="contents">
<a href="timer__ev__emitter_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow-IPC: Core</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="preprocessor">#include &quot;<a class="code" href="timer__ev__emitter_8hpp.html">ipc/util/sync_io/detail/timer_ev_emitter.hpp</a>&quot;</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;<a class="code" href="detail_2util__fwd_8hpp.html">ipc/util/detail/util_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &lt;flow/error/error.hpp&gt;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#include &lt;boost/move/make_unique.hpp&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceipc_1_1util_1_1sync__io.html">ipc::util::sync_io</a></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span>{</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="comment">// Implementations.</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#a8a4720c9fc5ecb15ce2efee16b4c3cee">   30</a></span><a class="code hl_function" href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#a8a4720c9fc5ecb15ce2efee16b4c3cee">Timer_event_emitter::Timer_event_emitter</a>(flow::log::Logger* logger_ptr, <a class="code hl_typedef" href="namespaceipc_1_1util.html#ae6ac47812a90d1287c61e0b7de7bc4f5">String_view</a> nickname_str) :</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span>  flow::log::Log_context(logger_ptr, <a class="code hl_enumeration" href="namespaceipc.html#a4ccdeed058222c635745a4dc830e99f7">Log_component</a>::S_UTIL),</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span>  m_nickname(nickname_str),</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span>  m_worker(get_logger(), std::string(<span class="stringliteral">&quot;tmr_ev-&quot;</span>) + m_nickname)</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span>{</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>  <a class="code hl_variable" href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#ad17e799f7c36c4c0cbc858637377f456">m_worker</a>.start();</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span>  FLOW_LOG_TRACE(<span class="stringliteral">&quot;Timer_event_emitter [&quot;</span> &lt;&lt; *<span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;]: Idle timer-emitter thread started.&quot;</span>);</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span>}</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#aab9cd218457e4fa5ce3bb6e1b59542ee">   39</a></span>flow::util::Timer <a class="code hl_function" href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#aab9cd218457e4fa5ce3bb6e1b59542ee">Timer_event_emitter::create_timer</a>()</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span>{</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span>  <span class="keyword">using </span>flow::util::Timer;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span>  <span class="keywordflow">return</span> Timer(*(<a class="code hl_variable" href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#ad17e799f7c36c4c0cbc858637377f456">m_worker</a>.task_engine()));</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span>}</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#ad2124aadd5025490aedf16958db4599c">   46</a></span><a class="code hl_typedef" href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#a1533a54927a64579fda02c61ec94b735">Timer_event_emitter::Timer_fired_read_end</a>* <a class="code hl_function" href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#ad2124aadd5025490aedf16958db4599c">Timer_event_emitter::create_timer_signal_pipe</a>()</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span>{</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span>  <span class="keyword">using </span>boost::asio::writable_pipe;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span>  <span class="keyword">using </span>boost::asio::connect_pipe;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span>  <span class="keyword">using </span>boost::movelib::make_unique;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span>  <span class="keyword">auto</span> read_end = make_unique&lt;Timer_fired_read_end&gt;(*(<a class="code hl_variable" href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#ad17e799f7c36c4c0cbc858637377f456">m_worker</a>.task_engine()));</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span>  <span class="keyword">auto</span> write_end = make_unique&lt;writable_pipe&gt;(*(<a class="code hl_variable" href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#ad17e799f7c36c4c0cbc858637377f456">m_worker</a>.task_engine()));</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span>  <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a> sys_err_code;</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span>  connect_pipe(*read_end, *write_end, sys_err_code);</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span>  <span class="keywordflow">if</span> (sys_err_code)</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span>  {</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span>    <span class="comment">// @todo Someday we should report this as an error, etc.  Low-priority, as at this stage everything is kaput.</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span>    FLOW_LOG_FATAL(<span class="stringliteral">&quot;connect_pipe() failed; this should never happen.  Details follow.&quot;</span>);</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span>    FLOW_ERROR_SYS_ERROR_LOG_FATAL();</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span>    assert(<span class="keyword">false</span> &amp;&amp; <span class="stringliteral">&quot;connect_pipe() failed; this should never happen.  Details follow.&quot;</span>); std::abort();</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span>    <span class="keywordflow">return</span> <span class="keyword">nullptr</span>;</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span>  }</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span>  <span class="comment">// else</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span>  <span class="keyword">auto</span>&amp; read_end_ref = <a class="code hl_variable" href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#afafdfa9e2c522cd3e12b4f1915f83b56">m_signal_pipe_readers</a>.emplace_back(std::move(read_end));</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span> </div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="preprocessor">#ifndef NDEBUG</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span>  <span class="keyword">const</span> <span class="keyword">auto</span> result =</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span>  <a class="code hl_variable" href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#ac2e6652bed4a80239d57a7fad2bab47c">m_signal_pipe_writers</a>.insert({ read_end_ref.get(),</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span>                                 std::move(write_end) });</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span>  assert(result.second);</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span> </div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span>  FLOW_LOG_TRACE(<span class="stringliteral">&quot;Timer_event_emitter [&quot;</span> &lt;&lt; *<span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;]: Pipe created; read-end ptr = [&quot;</span> &lt;&lt; read_end_ref.get() &lt;&lt; <span class="stringliteral">&quot;].&quot;</span>);</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span> </div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span>  <span class="keywordflow">return</span> read_end_ref.get();</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span>} <span class="comment">// Timer_event_emitter::create_timer_signal_pipe()</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span> </div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#a838497cd832da97bf1d52a7b8a85734c">   81</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#a838497cd832da97bf1d52a7b8a85734c">Timer_event_emitter::timer_async_wait</a>(flow::util::Timer* timer, <a class="code hl_typedef" href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#a1533a54927a64579fda02c61ec94b735">Timer_fired_read_end</a>* read_end)</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span>{</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span>  FLOW_LOG_TRACE(<span class="stringliteral">&quot;Timer_event_emitter [&quot;</span> &lt;&lt; *<span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;]: Starting timer async-wait; when/if it fires, &quot;</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span>                 <span class="stringliteral">&quot;we will write to write-end corresponding to read-end ptr = [&quot;</span> &lt;&lt; read_end &lt;&lt; <span class="stringliteral">&quot;].&quot;</span>);</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span> </div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span>  <span class="comment">/* Careful: this is a user thread, but the handler below is in our worker thread.</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment">   * Accessing m_signal_pipe_writers inside there would be not thread-safe, as if some timer happens to fire,</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment">   * while they (say) create_timer_signal_pipe() for another future timer&#39;s purposes, things could explode.</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment">   * Save the value now; it is accurate and guaranteed valid until `*this` dies (which can only happen</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment">   * after thread is joined, meaning handler couldn&#39;t possibly be executing). */</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span>  <span class="keyword">const</span> <span class="keyword">auto</span> it = <a class="code hl_variable" href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#ac2e6652bed4a80239d57a7fad2bab47c">m_signal_pipe_writers</a>.find(read_end);</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span>  assert((it != <a class="code hl_variable" href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#ac2e6652bed4a80239d57a7fad2bab47c">m_signal_pipe_writers</a>.end()) &amp;&amp; <span class="stringliteral">&quot;timer_async_wait() invoked on read_end from another *this?&quot;</span>);</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span>  <span class="keyword">const</span> <span class="keyword">auto</span> write_end = it-&gt;second.get();</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span> </div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span>  timer-&gt;async_wait([<span class="keyword">this</span>, write_end, read_end](<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>&amp; async_err_code)</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span>  {</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span>    <span class="keyword">auto</span> sys_err_code = async_err_code;</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span> </div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span>    <span class="keywordflow">if</span> (sys_err_code == boost::asio::error::operation_aborted)</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span>    {</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span>      <span class="comment">// As promised we only report actual firings.  Stuff is shutting down, or timer canceled.  GTFO.</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span>      <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span>    }</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span>    <span class="comment">// else</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span> </div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span>    <span class="keywordflow">if</span> (sys_err_code)</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span>    {</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span>      <span class="comment">/* This decision (to simply pretend it was a success code) is borrowed from flow::async::schedule_*().</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment">       * assert() is another option, but use Flow wisdom.  Note, e.g., snd_auto_ping_now() does the same. */</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span>      FLOW_ERROR_SYS_ERROR_LOG_WARNING();</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span>      FLOW_LOG_WARNING(<span class="stringliteral">&quot;Timer_event_emitter [&quot;</span> &lt;&lt; *<span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;]: &quot;</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span>                       <span class="stringliteral">&quot;Timer system error; just logged; totally unexpected; pretending it fired normally.&quot;</span>);</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span>    }</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span> </div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span>    FLOW_LOG_TRACE(<span class="stringliteral">&quot;Timer_event_emitter [&quot;</span> &lt;&lt; *<span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;]: Timer fired.  Pushing byte to pipe; &quot;</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span>                   <span class="stringliteral">&quot;read_end ptr = [&quot;</span> &lt;&lt; read_end &lt;&lt; <span class="stringliteral">&quot;].  User code should detect event soon and cause byte &quot;</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span>                   <span class="stringliteral">&quot;to be popped.&quot;</span>);</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span> </div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span>    <a class="code hl_function" href="namespaceipc_1_1util.html#a5429c6225cc9a271ad8c0041d99c236b">util::pipe_produce</a>(get_logger(), write_end);</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span>  }); <span class="comment">// timer-&gt;async_wait()</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span>} <span class="comment">// Timer_event_emitter::timer_async_wait()</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span> </div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#a80a0549f49fafc358763e9325c31256b">  123</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#a80a0549f49fafc358763e9325c31256b">Timer_event_emitter::consume_timer_firing_signal</a>(<a class="code hl_typedef" href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#a1533a54927a64579fda02c61ec94b735">Timer_fired_read_end</a>* read_end)</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span>{</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span>  FLOW_LOG_TRACE(<span class="stringliteral">&quot;Timer_event_emitter [&quot;</span> &lt;&lt; *<span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;]: Timer presumably fired and pushed byte to pipe; &quot;</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span>                 <span class="stringliteral">&quot;we now pop it.&quot;</span>);</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span> </div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span>  <a class="code hl_function" href="namespaceipc_1_1util.html#a814272e555c0592b0caf92b7bc3d64b3">util::pipe_consume</a>(get_logger(), read_end);</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span>} <span class="comment">// Timer_event_emitter::consume_timer_firing_signal()</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span> </div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#a07ebecd1cab6bf716b3482047e67eeb9">  131</a></span>std::ostream&amp; <a class="code hl_function" href="namespaceipc_1_1util_1_1sync__io.html#adef3ac3be5570b22492dd9214b4cb3da">operator&lt;&lt;</a>(std::ostream&amp; os, <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html">Timer_event_emitter</a>&amp; val)</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span>{</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span>  <span class="keywordflow">return</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span>    os &lt;&lt; <span class="charliteral">&#39;[&#39;</span> &lt;&lt; val.<a class="code hl_variable" href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#a63c1e77a76775134b5a6d4725d58be81">m_nickname</a> &lt;&lt; <span class="stringliteral">&quot;]@&quot;</span> &lt;&lt; <span class="keyword">static_cast&lt;</span><span class="keyword">const </span><span class="keywordtype">void</span>*<span class="keyword">&gt;</span>(&amp;val);</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span> </div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span>}</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span> </div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span>} <span class="comment">// namespace ipc::util::sync_io</span></div>
<div class="ttc" id="aclassipc_1_1util_1_1sync__io_1_1Timer__event__emitter_html"><div class="ttname"><a href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html">ipc::util::sync_io::Timer_event_emitter</a></div><div class="ttdoc">An object of this type, used internally to implement sync_io-pattern objects that require timer event...</div><div class="ttdef"><b>Definition:</b> <a href="timer__ev__emitter_8hpp_source.html#l00145">timer_ev_emitter.hpp:148</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1sync__io_1_1Timer__event__emitter_html_a1533a54927a64579fda02c61ec94b735"><div class="ttname"><a href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#a1533a54927a64579fda02c61ec94b735">ipc::util::sync_io::Timer_event_emitter::Timer_fired_read_end</a></div><div class="ttdeci">boost::asio::readable_pipe Timer_fired_read_end</div><div class="ttdoc">Object representing the read end of IPC mechanism, where readable status indicates the associated tim...</div><div class="ttdef"><b>Definition:</b> <a href="timer__ev__emitter_8hpp_source.html#l00162">timer_ev_emitter.hpp:162</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1sync__io_1_1Timer__event__emitter_html_a63c1e77a76775134b5a6d4725d58be81"><div class="ttname"><a href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#a63c1e77a76775134b5a6d4725d58be81">ipc::util::sync_io::Timer_event_emitter::m_nickname</a></div><div class="ttdeci">const std::string m_nickname</div><div class="ttdoc">Nickname as passed to ctor.</div><div class="ttdef"><b>Definition:</b> <a href="timer__ev__emitter_8hpp_source.html#l00244">timer_ev_emitter.hpp:244</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1sync__io_1_1Timer__event__emitter_html_a80a0549f49fafc358763e9325c31256b"><div class="ttname"><a href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#a80a0549f49fafc358763e9325c31256b">ipc::util::sync_io::Timer_event_emitter::consume_timer_firing_signal</a></div><div class="ttdeci">void consume_timer_firing_signal(Timer_fired_read_end *read_end)</div><div class="ttdoc">Must be called after a timer_async_wait()-triggered timer fired, before invoking that method for the ...</div><div class="ttdef"><b>Definition:</b> <a href="timer__ev__emitter_8cpp_source.html#l00123">timer_ev_emitter.cpp:123</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1sync__io_1_1Timer__event__emitter_html_a838497cd832da97bf1d52a7b8a85734c"><div class="ttname"><a href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#a838497cd832da97bf1d52a7b8a85734c">ipc::util::sync_io::Timer_event_emitter::timer_async_wait</a></div><div class="ttdeci">void timer_async_wait(flow::util::Timer *timer, Timer_fired_read_end *read_end)</div><div class="ttdoc">To be used on a timer T returned by create_timer(), this is the replacement for the usual T....</div><div class="ttdef"><b>Definition:</b> <a href="timer__ev__emitter_8cpp_source.html#l00081">timer_ev_emitter.cpp:81</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1sync__io_1_1Timer__event__emitter_html_a8a4720c9fc5ecb15ce2efee16b4c3cee"><div class="ttname"><a href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#a8a4720c9fc5ecb15ce2efee16b4c3cee">ipc::util::sync_io::Timer_event_emitter::Timer_event_emitter</a></div><div class="ttdeci">Timer_event_emitter(flow::log::Logger *logger_ptr, String_view nickname_str)</div><div class="ttdoc">Constructs emitter, creating idle thread managing no timers.</div><div class="ttdef"><b>Definition:</b> <a href="timer__ev__emitter_8cpp_source.html#l00030">timer_ev_emitter.cpp:30</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1sync__io_1_1Timer__event__emitter_html_aab9cd218457e4fa5ce3bb6e1b59542ee"><div class="ttname"><a href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#aab9cd218457e4fa5ce3bb6e1b59542ee">ipc::util::sync_io::Timer_event_emitter::create_timer</a></div><div class="ttdeci">flow::util::Timer create_timer()</div><div class="ttdoc">Creates idle timer for use with timer_async_wait() subsequently.</div><div class="ttdef"><b>Definition:</b> <a href="timer__ev__emitter_8cpp_source.html#l00039">timer_ev_emitter.cpp:39</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1sync__io_1_1Timer__event__emitter_html_ac2e6652bed4a80239d57a7fad2bab47c"><div class="ttname"><a href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#ac2e6652bed4a80239d57a7fad2bab47c">ipc::util::sync_io::Timer_event_emitter::m_signal_pipe_writers</a></div><div class="ttdeci">boost::unordered_map&lt; Timer_fired_read_end *, boost::movelib::unique_ptr&lt; boost::asio::writable_pipe &gt; &gt; m_signal_pipe_writers</div><div class="ttdoc">Stores the write-ends of the pipes created in create_timer_signal_pipe(), indexed by pointer to their...</div><div class="ttdef"><b>Definition:</b> <a href="timer__ev__emitter_8hpp_source.html#l00266">timer_ev_emitter.hpp:266</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1sync__io_1_1Timer__event__emitter_html_ad17e799f7c36c4c0cbc858637377f456"><div class="ttname"><a href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#ad17e799f7c36c4c0cbc858637377f456">ipc::util::sync_io::Timer_event_emitter::m_worker</a></div><div class="ttdeci">flow::async::Single_thread_task_loop m_worker</div><div class="ttdoc">The thread where (only) timer-firing events (from create_timer()-created Timers) execute.</div><div class="ttdef"><b>Definition:</b> <a href="timer__ev__emitter_8hpp_source.html#l00250">timer_ev_emitter.hpp:250</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1sync__io_1_1Timer__event__emitter_html_ad2124aadd5025490aedf16958db4599c"><div class="ttname"><a href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#ad2124aadd5025490aedf16958db4599c">ipc::util::sync_io::Timer_event_emitter::create_timer_signal_pipe</a></div><div class="ttdeci">Timer_fired_read_end * create_timer_signal_pipe()</div><div class="ttdoc">Creates, and internally stores, an IPC mechanism instance intended for use with a given create_timer(...</div><div class="ttdef"><b>Definition:</b> <a href="timer__ev__emitter_8cpp_source.html#l00046">timer_ev_emitter.cpp:46</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1sync__io_1_1Timer__event__emitter_html_afafdfa9e2c522cd3e12b4f1915f83b56"><div class="ttname"><a href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#afafdfa9e2c522cd3e12b4f1915f83b56">ipc::util::sync_io::Timer_event_emitter::m_signal_pipe_readers</a></div><div class="ttdeci">std::vector&lt; boost::movelib::unique_ptr&lt; Timer_fired_read_end &gt; &gt; m_signal_pipe_readers</div><div class="ttdoc">The readers (never null) returned by create_timer_signal_pipe().</div><div class="ttdef"><b>Definition:</b> <a href="timer__ev__emitter_8hpp_source.html#l00258">timer_ev_emitter.hpp:258</a></div></div>
<div class="ttc" id="adetail_2util__fwd_8hpp_html"><div class="ttname"><a href="detail_2util__fwd_8hpp.html">util_fwd.hpp</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_1_1sync__io_html"><div class="ttname"><a href="namespaceipc_1_1util_1_1sync__io.html">ipc::util::sync_io</a></div><div class="ttdoc">Contains common code, as well as important explanatory documentation in the following text,...</div><div class="ttdef"><b>Definition:</b> <a href="detail_2util__fwd_8hpp_source.html#l00208">util_fwd.hpp:209</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_1_1sync__io_html_adef3ac3be5570b22492dd9214b4cb3da"><div class="ttname"><a href="namespaceipc_1_1util_1_1sync__io.html#adef3ac3be5570b22492dd9214b4cb3da">ipc::util::sync_io::operator&lt;&lt;</a></div><div class="ttdeci">std::ostream &amp; operator&lt;&lt;(std::ostream &amp;os, const Timer_event_emitter &amp;val)</div><div class="ttdoc">Prints string representation of the given Timer_event_emitter to the given ostream.</div><div class="ttdef"><b>Definition:</b> <a href="timer__ev__emitter_8cpp_source.html#l00131">timer_ev_emitter.cpp:131</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a5429c6225cc9a271ad8c0041d99c236b"><div class="ttname"><a href="namespaceipc_1_1util.html#a5429c6225cc9a271ad8c0041d99c236b">ipc::util::pipe_produce</a></div><div class="ttdeci">void pipe_produce(flow::log::Logger *logger_ptr, Pipe_writer *pipe)</div><div class="ttdoc">Writes a byte to the given pipe writer.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2util_2detail_2util_8cpp_source.html#l00067">util.cpp:67</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a814272e555c0592b0caf92b7bc3d64b3"><div class="ttname"><a href="namespaceipc_1_1util.html#a814272e555c0592b0caf92b7bc3d64b3">ipc::util::pipe_consume</a></div><div class="ttdeci">void pipe_consume(flow::log::Logger *logger_ptr, Pipe_reader *pipe)</div><div class="ttdoc">Reads a byte via the given pipe reader.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2util_2detail_2util_8cpp_source.html#l00096">util.cpp:96</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_ae6ac47812a90d1287c61e0b7de7bc4f5"><div class="ttname"><a href="namespaceipc_1_1util.html#ae6ac47812a90d1287c61e0b7de7bc4f5">ipc::util::String_view</a></div><div class="ttdeci">flow::util::String_view String_view</div><div class="ttdoc">Short-hand for Flow's String_view.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00115">util_fwd.hpp:115</a></div></div>
<div class="ttc" id="anamespaceipc_html_a4ccdeed058222c635745a4dc830e99f7"><div class="ttname"><a href="namespaceipc.html#a4ccdeed058222c635745a4dc830e99f7">ipc::Log_component</a></div><div class="ttdeci">Log_component</div><div class="ttdoc">The flow::log::Component payload enumeration containing various log components used by Flow-IPC inter...</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00322">common.hpp:323</a></div></div>
<div class="ttc" id="anamespaceipc_html_aa3192e586cc45d3e7c22463bf2760f89"><div class="ttname"><a href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">ipc::Error_code</a></div><div class="ttdeci">flow::Error_code Error_code</div><div class="ttdoc">Short-hand for flow::Error_code which is very common.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00298">common.hpp:298</a></div></div>
<div class="ttc" id="atimer__ev__emitter_8hpp_html"><div class="ttname"><a href="timer__ev__emitter_8hpp.html">timer_ev_emitter.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu May 2 2024 23:56:38 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
